MGLOfflinePack

An MGLOfflinePack represents a collection of resources necessary for viewing a region offline to a local database.

To create an instance of MGLOfflinePack, use the +[MGLOfflineStorage addPackForRegion:withContext:completionHandler:] method. A pack created using -[MGLOfflinePack init] is immediately invalid.

The region for which the pack manages resources.

Objective-C

Swift

Arbitrary data stored alongside the downloaded resources.

The context typically holds application-specific information for identifying the pack, such as a user-selected name.

To change the value of this property, use the -setContext:completionHandler: method. If you access this property after calling that method but before its completion handler is called, this property鈥檚 value may not reflect the new value that you specify.

Objective-C

Swift

Associates arbitrary contextual data with the offline pack, replacing any context that was previously associated with the offline pack.

Setting the context is asynchronous. The context property may not be updated until the completion handler is called.

Objective-C

Swift

context

The new context to associate with the offline pack.

completion

The completion handler to call when the context has been updated. If there is an error setting the context, the error is passed into the completion handler.

The pack鈥檚 current state.

The state of an inactive or completed pack is computed lazily and is set to MGLOfflinePackStateUnknown by default. To request the pack鈥檚 status, use the -requestProgress method. To get notified when the state becomes known and when it changes, observe KVO change notifications on this pack鈥檚 state key path. Alternatively, you can add an observer for MGLOfflinePackProgressChangedNotifications about this pack that come from the default notification center.

Objective-C

Swift

The pack鈥檚 current progress.

The progress of an inactive or completed pack is computed lazily, and all its fields are set to 0 by default. To request the pack鈥檚 progress, use the -requestProgress method. To get notified when the progress becomes known and when it changes, observe KVO change notifications on this pack鈥檚 state key path. Alternatively, you can add an observer for MGLOfflinePackProgressChangedNotifications about this pack that come from the default notification center.

Objective-C

Swift

Resumes downloading if the pack is inactive.

When a pack resumes after being suspended, it may begin by iterating over the already downloaded resources. As a result, the progress structure鈥檚 countOfResourcesCompleted field may revert to 0 before rapidly returning to the level of progress at the time the pack was suspended.

To temporarily suspend downloading, call the -suspend method.

Objective-C

Swift

Temporarily stops downloading if the pack is active.

A pack suspends asynchronously, so some network requests may be sent after this method is called. Regardless, the progress property will not be updated until -resume is called.

If the pack previously reached a higher level of progress before being suspended, it may wait to suspend until it returns to that level.

To resume downloading, call the -resume method.

Objective-C

Swift

Request an asynchronous update to the pack鈥檚 state and progress properties.

The state and progress of an inactive or completed pack are computed lazily. If you need the state or progress of a pack whose state property is currently set to MGLOfflinePackStateUnknown, observe KVO change notifications on this pack鈥檚 state key path, then call this method. Alternatively, you can add an observer for MGLOfflinePackProgressChangedNotification about this pack that come from the default notification center.

Objective-C

Swift